docs: convert HTML comment to markdown blockquote for GitHub visibility#569
Closed
waynesun09 wants to merge 1 commit intosourcebot-dev:mainfrom
Closed
docs: convert HTML comment to markdown blockquote for GitHub visibility#569waynesun09 wants to merge 1 commit intosourcebot-dev:mainfrom
waynesun09 wants to merge 1 commit intosourcebot-dev:mainfrom
Conversation
Replace invisible HTML comment syntax with markdown blockquote in CHANGELOG.md to ensure important release note is visible on GitHub: - Line 10: Note about bumping MCP package for breaking changes HTML comments (<!-- -->) don't render on GitHub, while markdown blockquotes (> **Note:**) are properly displayed to maintainers and contributors. Also removed completed note about v4.4.0 API changes as requested. Signed-off-by: Wayne Sun <gsun@redhat.com>
Contributor
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace invisible HTML comment syntax with markdown blockquote in CHANGELOG.md to ensure important release note is visible on GitHub.
Changes
Rationale
HTML comments (
<!-- -->) don't render on GitHub's markdown viewer, while markdown blockquotes (> **Note:**) are properly displayed to maintainers and contributors reviewing the changelog.This ensures critical release coordination notes are visible to all team members.